home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / X11 / proxymngr.z / proxymngr
Text File  |  1998-10-20  |  9KB  |  199 lines
  1.  
  2.  
  3.  
  4.      PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))        PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           proxymngr - proxy manager service
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           pppprrrrooooxxxxyyyymmmmnnnnggggrrrr [----ccccoooonnnnffffiiiigggg _f_i_l_e_n_a_m_e] [----ttttiiiimmmmeeeeoooouuuutttt _s_e_c_o_n_d_s] [----rrrreeeettttrrrriiiieeeessss #]
  13.           [----vvvveeeerrrrbbbboooosssseeee]
  14.  
  15.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.           The proxy manager (proxymngr) is responsible for resolving
  17.           requests from xfindproxy (and other similar clients),
  18.           starting new proxies when appropriate, and keeping track of
  19.           all of the available proxy services.  The proxy manager
  20.           strives to reuse existing proxies whenever possible.
  21.  
  22.           There are two types of proxies that the proxy manager deals
  23.           with, _m_a_n_a_g_e_d and _u_n_m_a_n_a_g_e_d proxies.
  24.  
  25.           A _m_a_n_a_g_e_d proxy is a proxy that is started ``on demand'' by
  26.           the proxy manager.
  27.  
  28.           An _u_n_m_a_n_a_g_e_d proxy, on the other hand, is started either at
  29.           system boot time, or manually by a system administrator.
  30.           The proxy manager is made aware of its existence, but no
  31.           attempt is made by the proxy manager to start unmanaged
  32.           proxies.
  33.  
  34.           The command line options that can be specified to pppprrrrooooxxxxyyyymmmmnnnnggggrrrr
  35.           are:
  36.  
  37.           ----ccccoooonnnnffffiiiigggg Used to override the default proxymngr config file.
  38.                   See below for more details about the config file.
  39.  
  40.           ----ttttiiiimmmmeeeeoooouuuutttt
  41.                   Sets the number of seconds between attempts made by
  42.                   the proxy manager to find an unmanaged proxy.  The
  43.                   default is 10.
  44.  
  45.           ----rrrreeeettttrrrriiiieeeessss
  46.                   Sets the maximum number of retries made by the proxy
  47.                   manager to find an an unmanaged proxy.  The default
  48.                   is 3.
  49.  
  50.           ----vvvveeeerrrrbbbboooosssseeee
  51.                   Causes various debugging and tracing records to be
  52.                   displayed as requests are received and proxies are
  53.                   started.
  54.  
  55.      PPPPrrrrooooxxxxyyyy MMMMaaaannnnaaaaggggeeeerrrr CCCCoooonnnnffffiiiigggg FFFFiiiilllleeee
  56.           The proxy manager maintains a local configuration file
  57.           describing the proxy services available.  This configuration
  58.           file is installed in /usr/X11R6.3/lib/X11/proxymngr/pmconfig
  59.           during the installation of proxymngr.  The location of the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))        PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))
  71.  
  72.  
  73.  
  74.           configuration file can be overwritten using the ----ccccoooonnnnffffiiiigggg
  75.           command line option.
  76.  
  77.           Aside from lines starting with an exclamation point for
  78.           comments, each line of the configuration file describes
  79.           either an unmanaged or managed proxy service.
  80.  
  81.           For unmanaged proxies, the format is:
  82.  
  83.                <service-name> unmanaged <proxy-address>
  84.  
  85.           service-name is the name of the unmanaged proxy service, and
  86.           must not contain any spaces, for example ``XFWP''.
  87.           service-name is case insenstive.
  88.  
  89.           proxy-address is the network address of the unmanaged proxy.
  90.           The format of the address is specific to the service-name.
  91.           For example, for the ``XFWP'' service, the proxy-address
  92.           might be ``firewall.x.org:100''.
  93.  
  94.           If there is more than one entry in the config file with the
  95.           same unmanaged service-name, the proxy manager will try to
  96.           use the proxies in the order presented in the config file.
  97.  
  98.           For managed proxies, the format is:
  99.  
  100.                <service-name> managed <command-to-start-proxy>
  101.  
  102.           service-name is the name of the managed proxy service, and
  103.           must not contain any spaces, for example ``LBX''.  service-
  104.           name is case insensitive.
  105.  
  106.           command-to-start-proxy is the command executed by the proxy
  107.           manager to start a new instance of the proxy.  If command-
  108.           to-start-proxy contains spaces, the complete command should
  109.           be surrounded by single quotes.  If desired, command-to-
  110.           start-proxy can be used to start a proxy on a remote
  111.           machine.  The specifics of the remote execution method used
  112.           to do this is not specified here.
  113.  
  114.      EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  115.           Here is a sample configuration file:
  116.  
  117.                ! proxy manager config file
  118.                !
  119.                ! Each line has the format:
  120.                !    <serviceName> managed <startCommand>
  121.                !        or
  122.                !    <serviceName> unmanaged <proxyAddress>
  123.                !
  124.                lbx managed /usr/X11R6.3/bin/lbxproxy
  125.                !
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))        PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))
  137.  
  138.  
  139.  
  140.                ! substitute site-specific info
  141.                xfwp unmanaged firewall:4444
  142.  
  143.  
  144.      PPPPRRRROOOOXXXXYYYY MMMMAAAANNNNAAAAGGGGEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  145.           When the proxy manager gets a request from xfindproxy (or
  146.           another similar client), its course of action will depend on
  147.           the service-name in question.
  148.  
  149.           For a managed proxy service, the proxy manager will find out
  150.           if any of the already running proxies for this service can
  151.           handle a new request.  If not, the proxy manager will
  152.           attempt to start up a new instance of the proxy (using the
  153.           command-to-start-proxy found in the config file).  If that
  154.           fails, an error will be returned to the caller.
  155.  
  156.           For an unmanaged proxy service, the proxy manager will look
  157.           in the config file to find all unmanaged proxies for this
  158.           service.  If there is more than one entry in the config file
  159.           with the same unmanaged service-name, the proxy manager will
  160.           try to use the proxies in the order presented in the config
  161.           file.  If none of the unmanged proxies can satisfy the
  162.           request, the proxy manager will timeout for a configurable
  163.           amount of time (specified by ----ttttiiiimmmmeeeeoooouuuutttt or default of 10) and
  164.           reattempt to find an unmanaged proxy willing to satisfy the
  165.           request.  The number of retries can be specified by the
  166.           ----rrrreeeettttrrrriiiieeeessss argument, or a default of 3 will be used.  If the
  167.           retries fail, the proxy manager has no choice but to return
  168.           an error to the caller (since the proxy manager can not
  169.           start unmanaged proxy services).
  170.  
  171.      BBBBUUUUGGGGSSSS
  172.           proxy manager listen port should be configurable.
  173.  
  174.           ----ttttiiiimmmmeeeeoooouuuutttt and ----rrrreeeettttrrrriiiieeeessss is not implemented in proxymngr.
  175.  
  176.           proxymngr does not utilize the ``options'' and ``host''
  177.           fields in the proxy management protocol GetProxyAddr
  178.           request.
  179.  
  180.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  181.           xfindproxy (1), xfwp (1), Proxy Management Protocol spec
  182.           V1.0
  183.  
  184.      AAAAUUUUTTTTHHHHOOOORRRR
  185.           Ralph Mor, X Consortium
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.